home *** CD-ROM | disk | FTP | other *** search
/ Zoom 2 / Zoom - Release 2 (1996)(Active Software)[!].iso / graphics / misc / opticon18 / opticon.doc < prev    next >
Text File  |  1978-06-28  |  4KB  |  96 lines
  1. OptIcon                                                               OptIcon
  2.  
  3.    NAME
  4.     OptIcon -- Optimize icon images for size and speed (V36)
  5.  
  6.    SYNOPSIS
  7.     OptIcon NAME/A/M,DEPTH=PLANES/N,NOEXPAND/S,CRITICAL/S,VERBOSE/S
  8.  
  9.    FUNCTION
  10.     OptIcon reads in given ".info" files and scans the icon image
  11.     in order to optimize the PlanePick and PlaneOnOff fields in the
  12.     icon Image structure.  This is a space-saving mechanism for image
  13.     data.
  14.     Rather than defining the image data for every plane of the RastPort,
  15.     you need define data only for the planes that are not entirely zero
  16.     or one.  As you define your Imagery, you will often find that most
  17.     of the planes ARE just as color selectors.  For instance, if you're
  18.     designing a two-color icon to use colors one and three, and the icon
  19.     will reside in a five-plane display, bit plane zero of your
  20.     imagery would be all ones, bit plane one would have data that
  21.     describes the imagery, and bit planes two through four would be
  22.     all zeroes.  Using these flags avoids wasting all that memory in
  23.     this way:  first, you specify which planes you want your data to
  24.     appear in using the PlanePick variable.  For each bit set in the
  25.     variable, the next "plane" of your image data is blitted to the
  26.     display.  For each bit clear in this variable, the corresponding bit
  27.     in PlaneOnOff is examined.  If that bit is clear, a "plane" of zeroes
  28.     will be used.  If the bit is set, ones will go out instead.
  29.     Note that if you want an Image that is only a filled rectangle, you
  30.     can get this by setting PlanePick to zero (pick no planes of data)
  31.     and set PlaneOnOff to describe the pen color of the rectangle.
  32.  
  33.    INPUTS
  34.     NAME          - name of the icon image file.  A trailing ".info"
  35.             is optional but not required.
  36.     DEPTH         - maximum number of bitplanes to be saved.
  37.     VERBOSE       - display input and output information for each icon.
  38.  
  39.    EXAMPLE
  40.     ;Remove all but the first 3 planes of the icon image for the
  41.     ;disk in drive DF0: but don't add any planes
  42.     opticon df0:disk planes=3 noexpand
  43.  
  44.    NOTES
  45.     Since the IconEdit from Commodore will always save 8 bitplane icons
  46.     the above example might be of great use to you.  (Note that 3 plane
  47.     images are not only smaller but also faster!)
  48.     Coming with OptIcon is the script PatchIcons which will recursively
  49.     descend all subdirectories of a given path deleting all but the first
  50.     3 planes of all icon images in that path.
  51.  
  52.     OptIcon now also allows you to expand your 8 or more color icons
  53.     for the use on a 16 or more color Workbench.  This is important due
  54.     to the new color system under OS3.x which always shifts the second
  55.     four colors to the end of the system palette.  Therefore you might
  56.     want to adapt an icon's color depth to the actual screenmode it is
  57.     used on.
  58.  
  59.    EXAMPLE
  60.     ;Remap the last 4 of at least 8 colors of the RAM DISK icon
  61.     ;to the last 4 colors in a 16 or more colors Workbench palette
  62.     opticon ram:disk planes=4
  63.  
  64.    BUGS
  65.     Commodore's PutDiskObject() currently [icon.library 40.1 (15.2.93)]
  66.     re-expands icon images using the PlanePick/PlaneOnOff mechanism and
  67.     in fact PutDiskObject() has quite a lot of problems doing so!
  68.     For this reason OptIcon will perform the PlanePick/PlaneOnOff
  69.     optimization only if the keyword CRITICAL is given in the command
  70.     line.
  71.  
  72.    DISCLAIMER
  73.     This file is part of the Icon2C and OptIcon distribution.
  74.  
  75.     Icon2C and OptIcon are free software; you can redistribute them
  76.     and/or modify them under the terms of the GNU General Public License
  77.     as published by the Free Software Foundation; either version 1 of
  78.     the License, or (at your option) any later version.
  79.  
  80.     Icon2C and Opticon are distributed in the hope that they will be
  81.     useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  82.     of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  83.     GNU General Public License for more details.
  84.  
  85.     You should have received a copy of the GNU General Public License
  86.     along with these programs; see the file COPYING.  If not, write to
  87.     the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  88.  
  89.    COPYRIGHT
  90.     Icon2C and OptIcon are Copyright (C)1994 by Tobias Ferber.
  91.     You can reach me via E-mail: ukjg@rz.uni-karlsruhe.de
  92.  
  93.    SEE ALSO
  94.     PatchIcons, Icon2C
  95.  
  96.